home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / apt-xapian-index / plugins / template.py < prev    next >
Text File  |  2009-07-14  |  3KB  |  86 lines
  1. class Template:
  2.     def info(self):
  3.         """
  4.         Return general information about the plugin.
  5.  
  6.         The information returned is a dict with various keywords:
  7.          
  8.          timestamp (required)
  9.            the last modified timestamp of this data source.  This will be used
  10.            to see if we need to update the database or not.  A timestamp of 0
  11.            means that this data source is either missing or always up to date.
  12.          values (optional)
  13.            an array of dicts { name: name, desc: description }, one for every
  14.            numeric value indexed by this data source.
  15.  
  16.         Note that this method can be called before init.  The idea is that, if
  17.         the timestamp shows that this plugin is currently not needed, then the
  18.         long initialisation can just be skipped.
  19.         """
  20.         return dict(timestamp = 0, values = [])
  21.  
  22.     def init(self, info, progress):
  23.         """
  24.         If needed, perform long initialisation tasks here.
  25.  
  26.         info is a dictionary with useful information.  Currently it contains
  27.         the following values:
  28.  
  29.           "values": a dict mapping index mnemonics to index numbers
  30.  
  31.         The progress indicator can be used to report progress.
  32.         """
  33.         pass
  34.  
  35.     def doc(self):
  36.         """
  37.         Return documentation information for this data source.
  38.  
  39.         The documentation information is a dictionary with these keys:
  40.           name: the name for this data source
  41.           shortDesc: a short description
  42.           fullDoc: the full description as a chapter in ReST format
  43.         """
  44.         #return dict(
  45.         #    name = "template",
  46.         #    shortDesc = "Example plugin that does nothing",
  47.         #    fullDoc = """
  48.         #    Here goes full documentation in ReST format
  49.         #    """
  50.         #)
  51.  
  52.         # Return None if you don't want this file to appear in the
  53.         # documentation.  Probably, only the Template plugin should do that.
  54.         return None
  55.  
  56.     def index(self, document, pkg):
  57.         """
  58.         Update the document with the information from this data source.
  59.  
  60.         document  is the document to update
  61.         pkg       is the python-apt Package object for this package
  62.         """
  63.         pass
  64.  
  65.     def indexDeb822(self, document, pkg):
  66.         """
  67.         Update the document with the information from this data source.
  68.  
  69.         This is alternative to index, and it is used when indexing with package
  70.         data taken from a custom Packages file.
  71.  
  72.         document  is the document to update
  73.         pkg       is the Deb822 object for this package
  74.         """
  75.         pass
  76.  
  77.  
  78.  
  79. def init():
  80.     """
  81.     Create and return the plugin object.
  82.  
  83.     Return None here to disable this plugin.
  84.     """
  85.     return Template()
  86.